home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / X11 / XFlush.z / XFlush
Encoding:
Text File  |  1998-10-30  |  5.5 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXFFFFlllluuuusssshhhh((((3333XXXX11111111))))       XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))        XXXXFFFFlllluuuusssshhhh((((3333XXXX11111111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XFlush, XSync, XEventsQueued, XPending - handle output
  10.           buffer or event queue
  11.  
  12.      SSSSYYYYNNNNTTTTAAAAXXXX
  13.           XFlush(_d_i_s_p_l_a_y)
  14.                 Display *_d_i_s_p_l_a_y;
  15.  
  16.           XSync(_d_i_s_p_l_a_y, _d_i_s_c_a_r_d)
  17.                 Display *_d_i_s_p_l_a_y;
  18.                 Bool _d_i_s_c_a_r_d;
  19.  
  20.           int XEventsQueued(_d_i_s_p_l_a_y, _m_o_d_e)
  21.                Display *_d_i_s_p_l_a_y;
  22.                int _m_o_d_e;
  23.  
  24.           int XPending(_d_i_s_p_l_a_y)
  25.                 Display *_d_i_s_p_l_a_y;
  26.  
  27.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  28.           _d_i_s_c_a_r_d   Specifies a Boolean value that indicates whether
  29.                     _X_S_y_n_c discards all events on the event queue.
  30.  
  31.           _d_i_s_p_l_a_y   Specifies the connection to the X server.
  32.  
  33.           _m_o_d_e      Specifies the mode.  You can pass _Q_u_e_u_e_d_A_l_r_e_a_d_y,
  34.                     _Q_u_e_u_e_d_A_f_t_e_r_F_l_u_s_h, or _Q_u_e_u_e_d_A_f_t_e_r_R_e_a_d_i_n_g.
  35.  
  36.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  37.           The _X_F_l_u_s_h function flushes the output buffer.  Most client
  38.           applications need not use this function because the output
  39.           buffer is automatically flushed as needed by calls to
  40.           _X_P_e_n_d_i_n_g, _X_N_e_x_t_E_v_e_n_t, and _X_W_i_n_d_o_w_E_v_e_n_t.  Events generated by
  41.           the server may be enqueued into the library's event queue.
  42.  
  43.           The _X_S_y_n_c function flushes the output buffer and then waits
  44.           until all requests have been received and processed by the X
  45.           server.  Any errors generated must be handled by the error
  46.           handler.  For each protocol error received by Xlib, _X_S_y_n_c
  47.           calls the client application's error handling routine (see
  48.           section 11.8.2).  Any events generated by the server are
  49.           enqueued into the library's event queue.
  50.  
  51.           Finally, if you passed _F_a_l_s_e, _X_S_y_n_c does not discard the
  52.           events in the queue.  If you passed _T_r_u_e, _X_S_y_n_c discards all
  53.           events in the queue, including those events that were on the
  54.           queue before _X_S_y_n_c was called.  Client applications seldom
  55.           need to call _X_S_y_n_c.
  56.  
  57.           If mode is _Q_u_e_u_e_d_A_l_r_e_a_d_y, _X_E_v_e_n_t_s_Q_u_e_u_e_d returns the number
  58.           of events already in the event queue (and never performs a
  59.           system call).  If mode is _Q_u_e_u_e_d_A_f_t_e_r_F_l_u_s_h, _X_E_v_e_n_t_s_Q_u_e_u_e_d
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXFFFFlllluuuusssshhhh((((3333XXXX11111111))))       XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))        XXXXFFFFlllluuuusssshhhh((((3333XXXX11111111))))
  71.  
  72.  
  73.  
  74.           returns the number of events already in the queue if the
  75.           number is nonzero.  If there are no events in the queue,
  76.           _X_E_v_e_n_t_s_Q_u_e_u_e_d flushes the output buffer, attempts to read
  77.           more events out of the application's connection, and returns
  78.           the number read.  If mode is _Q_u_e_u_e_d_A_f_t_e_r_R_e_a_d_i_n_g,
  79.           _X_E_v_e_n_t_s_Q_u_e_u_e_d returns the number of events already in the
  80.           queue if the number is nonzero. If there are no events in
  81.           the queue, _X_E_v_e_n_t_s_Q_u_e_u_e_d attempts to read more events out of
  82.           the application's connection without flushing the output
  83.           buffer and returns the number read.
  84.  
  85.           _X_E_v_e_n_t_s_Q_u_e_u_e_d always returns immediately without I/O if
  86.           there are events already in the queue.  _X_E_v_e_n_t_s_Q_u_e_u_e_d with
  87.           mode _Q_u_e_u_e_d_A_f_t_e_r_F_l_u_s_h is identical in behavior to _X_P_e_n_d_i_n_g.
  88.           _X_E_v_e_n_t_s_Q_u_e_u_e_d with mode _Q_u_e_u_e_d_A_l_r_e_a_d_y is identical to the
  89.           _X_Q_L_e_n_g_t_h function.
  90.  
  91.           The _X_P_e_n_d_i_n_g function returns the number of events that have
  92.           been received from the X server but have not been removed
  93.           from the event queue.  _X_P_e_n_d_i_n_g is identical to
  94.           _X_E_v_e_n_t_s_Q_u_e_u_e_d with the mode _Q_u_e_u_e_d_A_f_t_e_r_F_l_u_s_h specified.
  95.  
  96.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  97.           AllPlanes(3X11), XIfEvent(3X11), XNextEvent(3X11),
  98.           XPutBackEvent(3X11)
  99.           _X_l_i_b - _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.